home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / dev / c / cweb31p9d.lha / CWeb / cweb.man < prev    next >
Text File  |  1993-12-06  |  4KB  |  128 lines
  1.  
  2.  
  3.  
  4. CWEB(1L)                                                 CWEB(1L)
  5.  
  6.  
  7. NAME
  8.        ctangle, cweave - translate CWEB to C and/or TeX
  9.  
  10. SYNOPSIS
  11.        ctangle  [  -bhp  ]  [  +s ] webfile[.w] [changefile[.ch]]
  12.        [outputfile[.c]]
  13.        cweave [ -bfhipx ] [ +ags ] webfile[.w]  [changefile[.ch]]
  14.        [outputfile[.tex]]
  15.  
  16.  
  17. DESCRIPTION
  18.        The ctangle program converts a CWEB source document into a
  19.        C program that may be compiled in the usual way.  The out-
  20.        put  file  includes #line specifications so that debugging
  21.        can be done in terms of the CWEB source file.
  22.  
  23.        The cweave program converts the same CWEB file into a  TeX
  24.        file  that  may be formatted and printed in the usual way.
  25.        It takes appropriate care of typographic details like page
  26.        layout  and  the  use  of  indentation, italics, boldface,
  27.        etc., and it supplies  extensive  cross-index  information
  28.        that it gathers automatically.
  29.  
  30.        CWEB  allows  you  to prepare a single document containing
  31.        all the information that is needed both to produce a  com-
  32.        pilable C program and to produce a well-formatted document
  33.        describing the program in as much detail as the writer may
  34.        desire.  The user of CWEB ought to be familiar with TeX as
  35.        well as C.
  36.  
  37.        The command line should have one, two, or three  names  on
  38.        it.   The first is taken as the CWEB file (and .w is added
  39.        if there is no extension). If that file cannot be  opened,
  40.        the  extension  .web  is  tried instead. (But .w is recom-
  41.        mended, since .web usually implies Pascal.)  If there is a
  42.        second  name,  it  is  a  change file (and .ch is added if
  43.        there is no extension).  The change file  overrides  parts
  44.        of  the  WEB  file,  as described in the documentation. If
  45.        there is a third name, it overrides the  default  name  of
  46.        the  output file, which is ordinarily the same as the name
  47.        of the input file (but on the current directory) with  the
  48.        extension .c or .tex.
  49.  
  50.        Options  in the command line may be either turned off with
  51.        - (if they are on by default) or turned on with + (if they
  52.        are  off  by  default). In fact, the options are processed
  53.        from left to right, so a sequence like -f  +f  corresponds
  54.        to +f (which is the default).
  55.  
  56.        The  -b  option  suppresses  the banner line that normally
  57.        appears on your terminal when ctangle  or  cweave  begins.
  58.        The  -h  option suppresses the happy message that normally
  59.        appears if the processing was successful.  The  -p  option
  60.        suppresses  progress  reports  (starred module numbers) as
  61.  
  62.  
  63.  
  64.                              11/15/93                            1
  65.  
  66.  
  67.  
  68.  
  69. CWEB(1L)                                                 CWEB(1L)
  70.  
  71.  
  72.        the processing takes place. If you say -bhp, you get noth-
  73.        ing but error messages.
  74.  
  75.        The  +s option prints statistics about memory usage at the
  76.        end of a run (assuming that the programs  have  been  com-
  77.        piled with the -DSTAT switch).
  78.  
  79.        There  are two other options applicable to cweave only: -f
  80.        means do not force a newline after every statement in  the
  81.        formatted  output.   -x  means omit the index and table of
  82.        contents.
  83.  
  84.        In addition to these options the Amiga version  of  cweave
  85.        has  two more  options:  +a  causes Amiga-specific type
  86.        identifiers to be recognized as keywords (e.g. UWORD).  +g
  87.        means  that  the German CWEB macros should be used instead
  88.        of the English ones.
  89.  
  90. FILES
  91.        cweb/cwebmac.tex    TeX macros used by cweave output.
  92.        amiga/cwebmacg.tex: German TeX macros for cweave output.
  93.        cweb/cwebman.tex    The user manual.
  94.        cweb/examples/wc.w  An introductory example.
  95.  
  96. SEE ALSO
  97.        Literate Programming by D.E. Knuth.
  98.        Weaving a Program by Wayne Sewell
  99.        tex(1), cc(1)
  100.  
  101. AUTHORS
  102.        Don  Knuth  wrote  WEB  for  TeX  and  Pascal. Silvio Levy
  103.        designed and developed CWEB by adapting  the  WEB  conven-
  104.        tions  to  C  and  by  recoding everything in CWEB.  Knuth
  105.        began using CWEB and made further refinements.
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.                              11/15/93                            2
  128.